/*
 * Copyright 2002-2004 the original author or authors.
 * 
 * Licensed under the Apache License, Version 2.0 (the "License"); you may not
 * use this file except in compliance with the License. You may obtain a copy of
 * the License at
 * 
 * http://www.apache.org/licenses/LICENSE-2.0
 * 
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
 * License for the specific language governing permissions and limitations under
 * the License.
 */
package org.springframework.richclient.table;

/**
 * @author Keith Donald
 */
public class ColumnToSort {
    private int level;

    private int columnIndex;

    private SortOrder sortOrder;

    public ColumnToSort(int level, int columnIndex) {
        this.level = level;
        this.columnIndex = columnIndex;
        this.sortOrder = SortOrder.ASCENDING;
    }

    public ColumnToSort(int level, int columnIndex, SortOrder sortOrder) {
        this.level = level;
        this.columnIndex = columnIndex;
        this.sortOrder = sortOrder;
    }

    public int getLevel() {
        return level;
    }

    public int getColumnIndex() {
        return this.columnIndex;
    }

    public SortOrder getSortOrder() {
        return this.sortOrder;
    }

    void setSortOrder(SortOrder sortOrder) {
        this.sortOrder = sortOrder;
    }

    public void toggleSortOrder() {
        setSortOrder(getSortOrder().flip());
    }

    public String toString() {
        return new StringBuffer("[ColumnToSort level=").append(level).append(", index=").append(columnIndex).append(
                ", sortOrder=").append(sortOrder).append("]").toString();
    }
}